Improve error reporting #2376
Merged
Improve error reporting #2376
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This prevents us from accidentally giving stack traces to exceptions that don't have them and giving misleading messages telling users to use --full-stacktrace when it won't actually do anything. Also deprecate ChiselException.chiselStackTrace which is no longer being used anywhere in this codebase.
New chisel3.internal.Errors replaces old anonymous class that would show up as chisel3.internal.ErrorLog$$anon$1 in error messages.
seldridge
approved these changes
Feb 1, 2022
| @@ -61,6 +61,24 @@ case object PrintFullStackTraceAnnotation | |||
|
|
|||
| } | |||
|
|
|||
| /** On recoverable errors, this will cause Chisel to throw an exception instead of continuing. | |||
| */ | |||
| case object ThrowOnFirstErrorAnnotation | |||
There was a problem hiding this comment.
Is this expected to be used as an annotation? If not, then this can be made private[chisel3.stage].
There was a problem hiding this comment.
It will be needed by chiseltest which only exposes Annotations and not arguments, but good suggestion in general
| @@ -207,4 +241,53 @@ class ChiselStageSpec extends AnyFlatSpec with Matchers with Utils { | |||
| exception.getStackTrace.mkString("\n") should include("java") | |||
| } | |||
|
|
|||
| it should "NOT add a stack trace to an exception with no stack trace" in { | |||
| val exception = intercept[java.lang.Exception] { | |||
| (new ChiselStage).emitChirrtl(new UserExceptionNoStackTrace) | |||
There was a problem hiding this comment.
Nit: only elaborate should be needed here (though there is no cost to using emitChirrtl.
There was a problem hiding this comment.
It seems that class ChiselStage doesn't have elaborate 🤦♂️
This tells Chisel not to aggregate recoverable errors but instead to throw an exception on the first one. This gives a stack trace for users who need it for debugging.
jackkoenig
force-pushed
the
improve-error-reporting
branch
from
2abff61 to
fc9f401
Compare
jackkoenig
added
the
Please Merge
mergify bot
pushed a commit
that referenced
this pull request
Feb 1, 2022
* Do not trim stack traces of exceptions with no stack trace This prevents us from accidentally giving stack traces to exceptions that don't have them and giving misleading messages telling users to use --full-stacktrace when it won't actually do anything. Also deprecate ChiselException.chiselStackTrace which is no longer being used anywhere in this codebase. * Add exception class for multiple-errors reported New chisel3.internal.Errors replaces old anonymous class that would show up as chisel3.internal.ErrorLog$$anon$1 in error messages. * Add new option --throw-on-first-error This tells Chisel not to aggregate recoverable errors but instead to throw an exception on the first one. This gives a stack trace for users who need it for debugging. (cherry picked from commit ff2e9c9)
mergify bot
added a commit
that referenced
this pull request
Feb 1, 2022
* Improve error reporting (#2376) * Do not trim stack traces of exceptions with no stack trace This prevents us from accidentally giving stack traces to exceptions that don't have them and giving misleading messages telling users to use --full-stacktrace when it won't actually do anything. Also deprecate ChiselException.chiselStackTrace which is no longer being used anywhere in this codebase. * Add exception class for multiple-errors reported New chisel3.internal.Errors replaces old anonymous class that would show up as chisel3.internal.ErrorLog$$anon$1 in error messages. * Add new option --throw-on-first-error This tells Chisel not to aggregate recoverable errors but instead to throw an exception on the first one. This gives a stack trace for users who need it for debugging. (cherry picked from commit ff2e9c9) * Waive MiMa false positives The waived change is to a package private constructor. Co-authored-by: Jack Koenig <koenig@sifive.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
14 tasks
jackkoenig
pushed a commit
that referenced
this pull request
Feb 28, 2023
…#2376) * Demonstrate a couple failing cases * Have TopWiring ignore unnamed declarations as potential sources
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired by @oharboe's comments here: ucb-bar/chiseltest#501 (comment).
This gives a little bit of refinement to error reporting.
$$anon$1in the error message--throw-on-first-errorto give users the option to throw exceptions instead of aggregating recoverable errorsContributor Checklist
docs/src?Type of Improvement
API Impact
This changes how errors are reported to make them a little more clear
Backend Code Generation Impact
No impact
Desired Merge Strategy
Release Notes
Improve recoverable error reporting and add
--throw-on-first-errorfor throwing exceptions instead of aggregating recoverable errors.Reviewer Checklist (only modified by reviewer)
3.4.x, [small] API extension:3.5.x, API modification or big change:3.6.0)?Please Merge?